home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 4 / MacMania 4.toast / / Demo's / Igor Demo Pro / 1 PutContentsIn Igor Pro Folder / More Extensions / File Loaders / CGLoadWave Documentation < prev    next >
Text File  |  1990-05-10  |  3KB  |  66 lines
  1. *** CGLoadWave ***
  2.  
  3. CGLoadWave adds a 'Load Cricket File' item to the 'Load Waves' submenu
  4. of Igor's 'File' menu. It behaves much like Igor's built in LoadWave operation 
  5. except that it loads Cricket Graph or general tab-delimited files.
  6.  
  7. There are five kinds of Cricket Graph files handled by CGLoadWave:
  8.  
  9.   Version 1.1 fast format files
  10.   Version 1.1 tab-delimited files
  11.   Version 1.2 files
  12.   Version 1.3 graph format files
  13.   Version 1.3 tab-delimited files.
  14.  
  15. CGLoadWave loads all of these file types. In addition, it can also load
  16. general tab-delimited TEXT files generated by programs other than
  17. Cricket Graph.
  18.  
  19. NOTE:
  20. We can't guarantee that CGLoadWave will work with every Cricket file,
  21. past, present or future.
  22.  
  23. A Cricket Graph tab-delimited file always begins with asterisk-CR. For
  24. non-Cricket Graph, tab-delimited files, the asterisk-CR is allowed but
  25. not required.
  26.  
  27. If the file being loaded is of type TEXT and is NOT a Cricket Graph file,
  28. then it is presumed to be a tab-delimited file. In this case, if the first
  29. non-space character of the file after the optional asterisk-CR is
  30. alphabetic, then the file is presumed to have column names.
  31. Otherwise, it is presumed to have no column names.
  32.  
  33. Note that Igor represents missing values in a column using the IEEE
  34. floating point symbol "NaN" which stands for "Not-a-Number". If your
  35. file contains missing values, you will see NaNs in the corresponding
  36. Igor wave.
  37.  
  38. CGLoadWave sets the Igor variable V_Flag to the number of columns
  39. loaded. It creates V_Flag if it does not already exist.
  40. CGLoadWave sets the string S_Filename to the name of the file that
  41. was loaded, but only if S_Filename already exists.
  42.  
  43. You can access CGLoadWave through its menu item or by invoking the 
  44. CGLoadWave operation from the command line or from a macro. The 
  45. CGLoadWave operation has the following syntax:
  46.  
  47. CGLoadWave [[/P=path]/O/D/I/Q/A[=basename]] "filename"
  48.  
  49.     /P=path specifies a path where file can be found.
  50.     /O causes new waves to overwrite existing waves of the same name.
  51.     /D causes the new waves to be double precision.
  52.     /I causes CGLoadWave to put up the standard open dialog.
  53.     /Q suppresses normal diagnostic messages during load.
  54.     /A automatically names new waves using default names.
  55.     /A=basename specifies base name to use in generating the wave names.
  56.     /N like /A but reuses existing names.
  57.     /N=basename like /A but reuses existing names.
  58.  
  59. If neither /A nor /N is used then wave names are generated from
  60. the column names in the file. In the case of a non-Cricket, tab-delimited file
  61. with no column names, the default "Column" is used as a base name.
  62.  
  63.     "filename" is a full file name for the file to load
  64.     or a partial file name if /P is used.
  65.     If "filename" is omitted CGLoadWave puts up the standard open dialog.
  66.